.\"
.\" $Header: /pub/cvsroot/mydns/doc/mydns.conf.5.in,v 1.11 2002/07/17 10:25:31 bboy Exp $
.\" mydns(8)
.\"
.\" Copyright (C) 2002  Don Moore <bboy@bboy.net>
.\"
.TH mydns.conf 5 "@PACKAGE_DATE@" "@PACKAGE_STRING@" "File Formats"
.SH NAME
mydns.conf \- \fBmydns\fP(8) configuration file.

.\"--------------------------------------------------------------------------
.\"  DESCRIPTION
.\"--------------------------------------------------------------------------
.SH DESCRIPTION
\fBmydns.conf\fP is read by \fBmydns\fP(8) on startup.  The default location
of this file is \fI/etc/mydns.conf\fP.
.LP
A \fBmydns.conf\fP might look something like this:
.IP
.nf
# /etc/mydns.conf
# Configuration file for the MyDNS name daemon

mysql-host = dbserver.example.com
mysql-user = mydnsuser
mysql-password = Gr8DNS!
.fi
.LP
Each line in the file may contain only one configuration option.
All allowable configuration options are described in the \fBOPTIONS\fP
section of this man page.  The syntax for a configuration line
is `\fIoption\fP [\fI=\fP \fIvalue\fP]'.
.LP
All text following a hash mark (`\fB#\fP') and empty lines are ignored.
If you need to specify an actual hash mark in a option value, escape it
by prefixing it with a backslash (`\fB\\\fP') character.
.LP
The \fBmydns\fP(8) program has a convenient command-line option that will
output all current options in \fBmydns.conf\fP format.  If you are creating
a \fBmydns.conf\fP file for the first time, this is a great way to create a
template for you to customize.  See \fBmydns\fP(8) for details.




.\"--------------------------------------------------------------------------
.\"  OPTIONS
.\"--------------------------------------------------------------------------
.SH OPTIONS
The following options are available to control the behavior
of \fBmydns\fP(8).  If an option has a default value, it is listed in
parentheses after the option syntax.

.IP "\fBmysql-host\fP = \fIhostname\fP (`\fIlocalhost\fP')"
Connect to the MySQL server located at \fIhostname\fP.

.IP "\fBmysql-user\fP = \fIusername\fP"
Use \fIusername\fP when authenticating with the MySQL server.

.IP "\fBmysql-pass\fP = \fIpassword\fP"
Use \fIpassword\fP when authenticating with the MySQL server.

.IP "\fBdatabase\fP = \fIname\fP (`\fImydns\fP')"
Read resource record information from the database called \fIname\fP.
The specified \fBdbuser\fP must have \fBSELECT\fP privileges on the
specified database.

.IP "\fBuser\fP = \fIusername\fP (`\fInobody\fP')"
Run the name daemon with the permissions of user \fIusername\fP.

.IP "\fBgroup\fP = \fIgroupname\fP (`\fInogroup\fP')"
Run the name daemon with the permissions of group \fIgroupname\fP.

.IP "\fBpidfile\fP = \fIfilename\fP (`\fI/var/run/named.pid\fP')"
Create a PID file for the name daemon called \fIfilename\fP.

.IP "\fBport\fP = \fIportnumber\fP (`\fI53\fP')"
The name daemon should listen on port \fIportnumber\fP.

.IP "\fBtimeout\fP = \fIseconds\fP (`\fI60\fP')"
Incoming queries time out if a reply could not be sent after \fIseconds\fP
have elapsed.

.IP "\fBmulticpu\fP = \fIcpucount\fP (`\fI1\fP')"
Run with multiple processes to support \fIcpucount\fP number of processors.

.IP "\fBcache-size\fP = \fInumber\fP (`\fI4096\fP')"
The zone cache will not contain more than \fInumber\fP entries.  The
average entry in the cache is about 128 bytes.
If \fInumber\fP is \fB0\fP, the zone cache will not be used.

.IP "\fBcache-expire\fP = \fIseconds\fP (`\fI300\fP')"
Entries expire from the zone cache once they are \fIseconds\fP old.
If \fIseconds\fP is \fB0\fP, the zone cache will not be used.


.\"--------------------------------------------------------------------------
.\"  SECURITY
.\"--------------------------------------------------------------------------
.SH SECURITY
The \fImydns.conf\fP file should be readable only by the root user (uid=0)
since it is very likely to contain database username and password
information.


.\"--------------------------------------------------------------------------
.\"  FILES
.\"--------------------------------------------------------------------------
.SH FILES
.I /etc/mydns.conf
.RS
The default location of the configuration file.


.\"--------------------------------------------------------------------------
.\"  SEE ALSO
.\"--------------------------------------------------------------------------
.SH "SEE ALSO"
.BR mydns (8)


.\" vi:set ts=3:
